Skip to main content

Webhook: ACTION_MISSED_REQUIRED

Обзор​

Webhook ACTION_MISSED_REQUIRED срабатывает, когда требуемое действие для задачи не выполняется в нужное время. Это уведомление гарантирует, что пользователи или системы будут проинформированы о таких пропущенных действиях, что позволяет им решить проблему и предотвратить возможные сбои.

Цель​

Этот webhook предоставляет своевременные оповещения о пропущенных критически важных действиях, обеспечивая ответственность и позволяя принимать корректирующие меры. Он особенно полезен для отслеживания обязательных шагов в рабочих процессах управления задачами или для временно чувствительных операций.

Формат запроса​

Webhook отправляет HTTP POST запрос с следующим JSON-пейлоадом:

{
   "entityId": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
   "type": "ACTION_MISSED_REQUIRED",
   "createdAt": "2024-12-16T13:00:01.448Z",
   "data": {
      "id": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T13:00:00.000Z",
      "endAt": "2024-12-16T14:00:00.000Z",
      "name": "Задача 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "0fa9feb3-6405-4d93-9e7e-9ccc91aadb60",
      "actionId": "cf5a70b6-3672-423c-8467-55c988715625"
   },
   "id": 201
}

Основные свойства​

Верхний уровень​

  • entityId: Уникальный идентификатор события пропущенного действия.
  • type: Тип webhook (ACTION_MISSED_REQUIRED).
  • createdAt: Временная метка, когда webhook был создан, в формате ISO 8601.
  • data: Содержит детальную информацию о пропущенном действии.

Поля данных​

Детали действия​

  • id: Уникальный идентификатор конкретного действия.
  • organizationId: Идентификатор организации, связанной с действием.
  • locationId: Идентификатор локации, где было пропущено действие.
  • startAt: Запланированное время начала действия, в формате ISO 8601.
  • endAt: Запланированное время окончания действия, в формате ISO 8601.
  • name: Название задачи, связанной с пропущенным действием.
  • assigneeIds: Список идентификаторов пользователей, назначенных на эту задачу или действие.
  • recurrenceRule: Правила повторения задачи (если применимо). Для этого события это поле равно null.
  • stepId: Идентификатор конкретного шага, связанного с действием.
  • actionId: Идентификатор пропущенного действия.

Пример ответа​

Пример пейлоада для успешного срабатывания webhook:

{
   "entityId": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
   "type": "ACTION_MISSED_REQUIRED",
   "createdAt": "2024-12-16T13:00:01.448Z",
   "data": {
      "id": "c2b700c6-169b-429b-93e2-cbdc9d11f9d3",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T13:00:00.000Z",
      "endAt": "2024-12-16T14:00:00.000Z",
      "name": "Задача 4",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": "0fa9feb3-6405-4d93-9e7e-9ccc91aadb60",
      "actionId": "cf5a70b6-3672-423c-8467-55c988715625"
   }
}

Преимущества​

  1. Своевременные уведомления: Обеспечивает оперативное информирование заинтересованных сторон о пропущенных действиях.
  2. Снижение ошибок: Позволяет предпринять корректирующие действия до того, как задержки или проблемы станут критическими.
  3. Ответственность: Помогает отслеживать и устранять причины пропущенных действий.
  4. Улучшение рабочих процессов: Способствует улучшению управления задачами, выявляя узкие места или пропущенные шаги.

Webhook ACTION_MISSED_REQUIRED является важным инструментом для обеспечения целостности выполнения задач и успешного функционирования рабочих процессов.